home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 23 / Amiga Format AFCD23 (Feb 1998, Issue 107).iso / -seriously_amiga- / shareware / programming / mui / mcc_datestring / docs / english / datestring_mcc.doc next >
Text File  |  1997-12-06  |  18KB  |  578 lines
  1.  
  2.                       Table of Contents
  3.  
  4.   Copyright                   - Copyright information
  5.   Distribution                - Copying conditions
  6.   Disclaimer                  - Legal Information
  7.   Trademark                   - Trademark information
  8.   Support/Updates             - How to get updates and support
  9.   Author                      - How to reach the author
  10.  
  11.   Description                 - What is DateString.mcc?
  12.   Requirements                - Requirements for using DateString.mcc
  13.  
  14.   Installation                - How to install DateString.mcc
  15.   Beta testers                - Installation information for beta testers
  16.  
  17.   Developer Info              - Information for developers
  18.  
  19.   History                     - Revision history of DateString.mcc
  20.   Todo                        - Todo list
  21.   Known problems              - List of known problems
  22.   Acknowledgments             - Acknowledgments
  23.   Please rate                 - Please rate DateString.mcc
  24.   Software                    - Software that uses DateString.mcc
  25.  
  26.  
  27.  
  28. Copyright
  29. ---------
  30.  
  31. This software and its documentation are copyright 1996-1997 by Kai Hofmann. All
  32. rights reserved!
  33.  
  34. - Permission for COMMERCIAL USE is only given by an extra available commercial
  35.   license that must be validated!
  36.   Contact me directly for this license, because it will be individually handed
  37.   out per your needs!
  38.  
  39. - Permission is hereby granted, without written agreement and without license,
  40.   to USE this software and its documentation for any NON-COMMERCIAL purpose,
  41.   provided that the above copyright notice and the following paragraph appear
  42.   in all copies of this software (Non-commercial includes Giftware!).
  43.  
  44.   Please send me a full version of your product at no cost including free
  45.   updates!
  46.   Extra money is welcome (For Bank Account see author - but *ONLY* send in DM
  47.   to this Bank Account!).
  48.  
  49.  
  50.  
  51. Distribution
  52. ------------
  53.  
  54. Permission is hereby granted, without written agreement and without license
  55. or royalty fees, to copy and distribute this software and its documentation
  56. for any purpose, provided that the above copyright notice and the following
  57. paragraphs appear in all copies of this software, to:
  58.  
  59. - All who will distribute this software for free!
  60. - All free accessible INTERNET servers!
  61. - All Aminet® sites
  62. - Fred Fish for his great Amiga-Software-Library
  63. - The German SAAR AG PD-Library
  64. - Angela Schmidt's Meeting Pearls serie
  65. - All others who do NOT take more than US$ 5.- for one disk that includes this
  66.   software!
  67.  
  68.  
  69.  
  70. IMPORTANT NOTE:
  71.  
  72. This package may not be included on any further Aminet CD-ROMs unless authors
  73. contributing their software to the CD-ROM, (without mentioning distribution
  74. "NoCD") are granted a copy of the CD *completely* *free* *of* *charge*.
  75.  
  76. The Meeting Pearls IV CD-ROM demonstrates that a Freebie policy is also
  77. possible with "very-low-budget" CD-ROMs (*), so Aminet should quickly
  78. re-establish the same Freebie policy it used up to Aminet CD 13.
  79.  
  80. (*) Suggested retail price for MP4 is DM 14,95/US$ 12/£ 8.95.
  81.  
  82.  
  83.  
  84. DISCLAIMER
  85. ----------
  86.  
  87. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE
  88. LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDER AND/OR OTHER
  89. PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
  90. EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  91. OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
  92. TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM
  93. PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
  94. CORRECTION.
  95.  
  96. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL
  97. ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY REDISTRIBUTE THE PROGRAM AS
  98. PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL,
  99. INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO
  100. USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
  101. RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE
  102. OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR
  103. OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
  104.  
  105. THE AUTHOR HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
  106. ENHANCEMENTS, OR MODIFICATIONS.
  107.  
  108.  
  109.  
  110. Trademark
  111. ---------
  112.  
  113. DateLib is a trademark of Kai Hofmann.
  114.  
  115. Amiga, AmigaDOS and Workbench are registered trademarks of Amiga International,
  116. Inc.
  117. Aminet is a registered trademark of Stefan Ossowskis Schatztruhe GmbH
  118. SAS/C is a registered trademark of SAS Institute Inc.
  119.  
  120. All other trademarked names used herein are used for the purposes of
  121. identification and for the benefit of the trademark holder. No infringement
  122. of trademarks is intended. Trademarks remain the property of the trademark
  123. holder.
  124.  
  125.  
  126.  
  127. Support/Updates
  128. ---------------
  129.  
  130. - Updates will be available via Aminet®
  131. - Support will be available via the authors email address and via
  132.   http://home.pages.de/~i07m/amiga/mui/DateString.html
  133.  
  134.  
  135.  
  136. Author
  137. ------
  138.  
  139. Kai Hofmann
  140. Arberger Heerstraße 92
  141. 28307 Bremen
  142. Germany
  143.  
  144. Phone: (+49)-(0)421/480780
  145. EMail: i07m@informatik.uni-bremen.de
  146.        i07m@zfn.uni-bremen.de
  147. IRC  : PowerStat@#AmigaGer
  148. WWW  : http://home.pages.de/~i07m/
  149.  
  150. Bank account : 1203 7503
  151. Account owner: Kai Hofmann
  152. Bank code    : 290 501 01
  153. Bank name    : Sparkasse in Bremen/Germany
  154.  
  155.  
  156.  
  157. Description
  158. -----------
  159.  
  160. DateString is a Custom Class of the Magic User Interface © by Stefan Stuntz.
  161. It's a subclass of string-class and date-class.
  162.  
  163. The idea of this class was born during developing my Gregor application.
  164.  
  165. MUI public custom class displaying a string gadget for date strings. The
  166. display format of the date string can be freely defined. An input string can
  167. be parsed by the given format string (see below), or in over 40 known
  168. formats.
  169.  
  170. DateString.mcc features that are of interest for users:
  171. - Handles years from 8 to 8000
  172. - Supports the Gregorian calendar reform
  173. - Supports 21 languages
  174. - Supports drops of other date objects and date-strings
  175. - Can be dragged around
  176. - A week can begin with any weekday
  177. - Supports various string formats via template
  178. - Can autodetect over 40 date-string formats
  179.  
  180. DateString.mcc features of interest for developers:
  181. - Based on Date.mcc
  182. - Supports MUIM_Import and MUIM_Export
  183. - The date can be read as day/month/year format or as JD or MJD
  184. - The date range can be restricted
  185. - Method to set the current date
  186. - Methods for increasing and decreasing the date
  187. - Method to compare with another date object
  188.  
  189.  
  190. The display format for a DateString object can be defined by the following
  191. formatting codes:
  192.  
  193. Syntax of Amiga compatible % commands:
  194.   %d - Day number with leading 0s
  195.   %e - Day number with leading spaces
  196.   %m - Month number with leading 0s
  197.   %h - Abbreviated month name
  198.   %b - Abbreviated month name
  199.   %B - Month name
  200.   %y - Year using two digits with leading 0s
  201.   %Y - Year using four digits with leading 0s
  202.   %j - Julian date
  203.   %w - Weekday number
  204.   %a - Abbreviated weekday name
  205.   %A - Weekday name
  206.   %U - Week number, taking Sunday as first day of week
  207.   %W - Week number, taking Monday as first day of week
  208.   %x - Same as "%m/%d/%y"
  209.   %D - Same as "%m/%d/%y"
  210.  
  211. Syntax of % commands:
  212.   %Ddf  - Day with leading 0s
  213.   %Ddv  - Day without leading 0s
  214.   %DDf  - Day within the year with leading 0s
  215.   %DDv  - Day within the year without leading 0s
  216.   %Dmf  - Month with leading 0s
  217.   %Dmv  - Month without leading 0s
  218.   %Dms  - Month string
  219.   %Dma  - Abbreviated month string
  220.   %Dy2f - 2-digit year with leading 0s
  221.   %Dy2v - 2-digit year without leading 0s
  222.   %Dy4f - 4-digit year with leading 0s
  223.   %Dy4v - 4-digit year without leading 0s
  224.   %Dys  - Scaliger year
  225.   %Dj   - JD date
  226.   %DJ   - MJD date
  227.   %Dwn  - Weekday number (1-7)
  228.   %Dws  - Weekday string
  229.   %Dwa  - Abbreviated weekday string
  230.   %DWf  - Weeknumber with leading 0s
  231.   %DWv  - Weeknumber without leading 0s
  232.   %DMf  - Age of the moon (0-30 ?) with leading 0s
  233.   %DMv  - Age of the moon (0-30 ?) without leading 0s
  234.  
  235. The date-string autodetection knows over 40 date-string formats:
  236.  
  237. (yesterday|today|tomorrow)
  238. wdn
  239. wdn[,] mmm d[ (yy|yyyy)]
  240. wdn[,] d[.][ ]mmm[,][ ][(yy|yyyy)]
  241. wdn[,] d[.][ ]m[.][ ][(yy|yyyy)]
  242. mmm d[ yyyy]
  243. mmm/d[/(yy|yyyy)]
  244. mmm-d[-(yy|yyyy)]
  245. yyyy[-]Www[-]n
  246. yyyy(-|/)m(-|/)d
  247. yyyy(-|/)n[n[n]]
  248. yy[-]Www[-]n
  249. yy-nnn
  250. d. mmm [(yy|yyyy)]
  251. d.m.[(yy|yyyy)]
  252. d-mmm[-(yy|yyyy)]
  253. d-m[-yyyy]
  254.                                  Detection condition:
  255. yyyymmdd   | ddmmyyyy            (valid date test)
  256. jjjjjjj    | yyyynnn             (1723980 >= JD <= 2914672)
  257. JJJJJ
  258. JJJJJJ     | yymmdd              (MJD <= 514671)
  259. d-m-yy     | yy-m-d              (yy > 31 | valid date test)
  260. d/m[/yyyy] | m/d/yyyy            (valid date test)
  261. d/m/yy     | m/d/yy   | yy/m/d   (valid date test)
  262.  
  263. Symbol explanation:
  264.  
  265. ()      = grouping
  266. |       = alternative
  267. []      = option
  268.  
  269. d       = day-number   (1-2 digits)
  270. dd      = 2 digit day
  271. n       = 1 digit day within week (1-7 = Mon-Sun)
  272. nnn     = 3 digit day within year
  273. ww      = 2 digit week within year
  274. m       = month-number (1-2 digits)
  275. mm      = 2 digit month
  276. yy      = 2 digit year
  277. yyyy    = 4 digit year
  278. JJJJJ   = 5 digit MJD
  279. JJJJJJ  = 6 digit MJD
  280. jjjjjjj = 7 digit JD
  281.  
  282. wdn     = weekday-name (long|short in any support language!)
  283. mmm     = month-name   (long|short in any support language!)
  284.           to the short version you can add a '.'
  285.  
  286.  
  287.  
  288. Requirements
  289. ------------
  290.  
  291. - MUI 3.1 (Version 12)
  292. - date.library
  293. - locale.library
  294.  
  295. - To use the Greek MCC-Install script you need the
  296.   "Greek Workbench" © AC Software
  297.  
  298. - To use the Russian MCC-Install script you need
  299.   "Rusifier" © Dmitry Mikhilov
  300.  
  301.  
  302.  
  303. Installation
  304. ------------
  305.  
  306. Only use the installer script!
  307. (The Installer must be in your system-path!)
  308.  
  309. If you use an Installer prior to V42 you should set the LANGUAGE Tooltype to
  310. your language. Installer V42 and better automatically use your current locale.
  311.  
  312.  
  313. Please note that the installer-script is very special, because:
  314.  
  315. - It features uninstallation
  316. - It is automated
  317. - It is very flexible
  318. - It is very intelligent (for an installer-script ;-)
  319. - It uses WrapGuide (if present) for the AmigaGuide®
  320.   documentation if running under a pre V39 system.
  321. - It can be reused by (hopefully) all other MUI custom classes, because the
  322.   authors of custom classes need to only change a few things:
  323.  
  324.   * The #copyright variable
  325.   * The #min_os_version and #min_os_revision variables
  326.   * The #min_mui_version and #min_mui_revision variables
  327.   * The #language_mcc and #language_mcc variables
  328.   * The P_CustomExists, P_CustomInstall and P_CustomUninstall procedures
  329.   * The 'APPNAME' tooltype within the MCC-Install icon.
  330.  
  331.  
  332.  
  333. Beta testers
  334. ------------
  335.  
  336. Version numbers of beta release will not change, so you must uninstall an
  337. earlier installed beta version before you can install a newer one!
  338.  
  339.  
  340.  
  341. Information for Developers
  342. --------------------------
  343.  
  344. There is no multiple inheritance for Boopsi/MUI for the moment, so we haven't
  345. any chance to create a real Date basis-class. But there is another way to have
  346. the same result (compatibility for all classes that are dealing with dates).
  347. The solution is called interface inheritance like it was done with IDL for
  348. CORBA.
  349. DateString.mcc inherits the interface from Date.mcc!
  350.  
  351.  
  352. Btw. it would be wise to use a
  353.  
  354.  SetAttrs(obj,
  355.             MUIA_Date_Year,  year,
  356.             MUIA_Date_Month, month,
  357.             MUIA_Date_Day,   day,
  358.           TAG_DONE
  359.          );
  360.  
  361. instead of single set()'s.
  362.  
  363.  
  364. - The following attributes are filtered out, so that they can't bring
  365.   a DateString object into trouble:
  366.   MUIA_String_Contents, MUIA_String_Accept, MUIA_String_EditHook,
  367.   MUIA_String_Integer, MUIA_String_LonelyEditHook, MUIA_String_Secret,
  368.   MUIA_String_Reject, MUIA_FillArea
  369.  
  370. - When MUIA_ObjectID is defined a DateString object will load/save the
  371.   following data during MUIM_Application_Load/MUIM_Application_Save
  372.   Day, Month, Year
  373.  
  374.  
  375.  
  376. History
  377. -------
  378.  
  379. 28.08.1996 -    First release on Aminet
  380. 06.09.1996 -    Second release on Aminet
  381.         * Implementing MUIM_Import, MUIM_Export
  382.         * Demo updated
  383. 13.12.1996 -    Third release on Aminet
  384.         * Using MUIV_Font_Button for buttons
  385.         * Adding great icons from Eric Gerard
  386.         * Fixed Assembler interface
  387.         * Fixed Modula-II interface
  388.         * Fixed Amiga-E interface
  389.         * Fixed Oberon interface
  390. 27.11.1997 -    Fourth release on Aminet
  391.         * Now based on Date.mcc 12.1
  392.         * Demo improved
  393.             * Added Blitz Basic 2 interface
  394.             * Added Cluster interface
  395.             * Added ARexx interface
  396.             * Added MUIBuilder3 description
  397.             * Added German documentation
  398.             * Own ParseDate() function
  399.         * Added AmigaGuide® V40 features to the documentation
  400.         * Added "Please rate" section to the documentation
  401.         * Added MagicWB readme
  402.         * MCC-Install 43.21
  403.         * Compiled with MCCLib 12.4
  404.         * MUIA_String_Contents will now be filtered
  405.         * Accepts drops of date-strings
  406.  
  407.  
  408.  
  409. Todo
  410. ----
  411.  
  412. - BubbleHelp error text
  413. - Accept string by pressing Tab
  414.  
  415.  
  416.  
  417. Known problems
  418. --------------
  419.  
  420. - I heard that using 'test' and then 'cancel' the test settings within the
  421.   MUI preference manager will not work as expected when in using your MUI
  422.   classes within Libs:MUI/ instead of MUI:Libs/MUI/ !!!
  423.  
  424. - Old versions of the program called 'PhoneCost' written by André Schenk
  425.   <schenkae@tick.informatik.uni-stuttgart.de> installed another
  426.   'date.library' into 'Libs:'.
  427.  
  428.  
  429.  
  430. Acknowledgments are going to the following people:
  431.  
  432. Rita Reichl         : for correcting my English and being my inspiration
  433.  
  434. James Cooper,
  435. Steve Krueger,
  436. Doug Walker         : For supporting SAS/C® after SAS suspends the support.
  437.  
  438. Stefan Stuntz       : for the Magic User Interface and for his support
  439. Klaus Melchior      : for the MUI custom class support
  440. Martin Huttenloher  : for MagicWB
  441. Udo Schuermann      : for WrapGuide
  442. Stefan Kost         : for ag2txt
  443. Jürgen Kohrmeyer    : for the rexxtricks.library
  444.  
  445. Eric Gerard         : for his great icons
  446.  
  447.  
  448.  
  449. Please rate
  450. -----------
  451.  
  452. Please rate DateString.mcc and MCC-Install. To do so, send an email to
  453. aminet-server@wuarchive.wustl.edu with the following content:
  454.  
  455. RATE dev/mui/MCC-Install.lha <num>
  456. RATE dev/mui/MCC_DateString.lha <num>
  457.  
  458. where <num> is a mark from 0..10 with 10 being the best.
  459. You can rate several programs in one mail.
  460.  
  461. Thank you!
  462.  
  463.  
  464.  
  465. Software
  466. --------
  467.  
  468. The following software products use DateString.mcc:
  469.  
  470.  
  471.  
  472.  
  473.                       This is a custom class of the
  474.  
  475.  
  476.                         MUI - MagicUserInterface
  477.  
  478.                  Copyright © 1993-1997 by Stefan Stuntz
  479.  
  480.  
  481. MUI is a system to generate and maintain graphical user interfaces. With
  482. the  aid  of  a  preferences program, the user of an application has the
  483. ability to customize the outfit according to his personal taste.
  484.  
  485. MUI is distributed as shareware. To obtain a complete package containing
  486. lots of examples and more information about registration please look for
  487. a  file  called  "muiXXusr.lha"  (XX means the latest version number) on
  488. your local bulletin boards or on public domain disks.
  489.  
  490.           If you want to register directly, feel free to send
  491.  
  492.  
  493.                          DM 30.-  or  US$ 20.-
  494.  
  495.                                   to
  496.  
  497.                              Stefan Stuntz
  498.                         Eduard-Spranger-Straße 7
  499.                              80935 München
  500.                                 GERMANY
  501.  
  502.  
  503.              Support and online registration are available at
  504.  
  505.                           http://www.sasg.com/
  506.  
  507.  
  508.  
  509.                  This product is based on or uses parts of
  510.  
  511.                      MagicWB - The Workbench Enhancer
  512.                      --------------------------------
  513.  
  514.                  Copyright © 1992-1997, Martin Huttenloher
  515.  
  516. If  you  use  and like this product you should very much consider to take a
  517. look  at  MagicWB,  which  is the authentic source of the style, colors and
  518. design  elements  contained  in  this  package.   It  features  hundreds of
  519. original  icons,  patterns, image-drawers,  dock-brushes and some specially
  520. designed  high-quality  fonts  to  improve the comfort & legibility of your
  521. daily Workbench session.
  522.  
  523. What  is  MagicWB?   MagicWB  is  a full replacement for the Graphical User
  524. Interface  of the Workbench and has become the standard visual interface on
  525. the  Amiga.  Over the last years MagicWB has received various merits and an
  526. overwhelming  response from Amiga magazines and users worldwide proclaiming
  527. it  "a  must  for  all  Amiga  users".   Even  commercial  applications are
  528. supporting the multi-colored look & style of MagicWB.
  529.  
  530. Get yourself the latest version of MagicWB and see for yourself the wonders
  531. it  can  do by automatically transforming your old and dull Amiga Workbench
  532. into  an impressive workstation environment that will be the envy of all PC
  533. Windows  and  Mac users.  Update yourself to the state-of-the-art workbench
  534. standard  everyone uses on the Amiga!  It is also your key to enjoy the new
  535. look & feel of many applications and other MWB add-ons and extensions.
  536.  
  537. MagicWB  is  distributed as shareware.  Get yourself the latest FREE PUBLIC
  538. RELEASE of MagicWB now:  It is called
  539.  
  540.                              ----------------
  541.                               MagicWB21p.lha
  542.                              ----------------
  543.  
  544. and  can  be found everywhere on Aminet (or your local BBS or public domain
  545. series).   Install it and witness the instant magic it performs on your old
  546. Amiga  Workbench.   Also  included  is the latest SASG registration program
  547. with which you can order and get the full registered version of MagicWB.
  548.  
  549.              If you want to order directly, feel free to send
  550.  
  551.                   DM 30.- or US$ 20.- (cash, no checks!)
  552.  
  553.                                     to
  554.  
  555.                             Martin Huttenloher
  556.                              Am Hochstraess 4
  557.                                D-89081 Ulm
  558.                                  Germany
  559.  
  560. You  may  also  choose  to visit the official MagicWB homepage on the world
  561. wide  web.   There you can find the latest news & support and even register
  562. your  MagicWB  online  (which is much more comfortable and faster). You can
  563. even  benefit  from  various  special offers & discounts for MagicWB if you
  564. order through our website!  Come and visit MagicWB at:
  565.  
  566.                           ----------------------
  567.                            http://www.sasg.com/
  568.                           ----------------------
  569.  
  570.               Save 20% by using the discounts on our website!
  571.  
  572.            Ordering online also saves you a lot of time and work!
  573.  
  574.  
  575.  
  576. WrapGuide is Copyright 1994-1995 Udo Schuermann
  577. All rights reserved
  578.